<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Application API &mdash; pySVG v0.2.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.2.0',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="pySVG v0.2.0 documentation" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li><a href="index.html">pySVG v0.2.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pysvg.core">
<h1>Application API<a class="headerlink" href="#module-pysvg.core" title="Permalink to this headline">¶</a></h1>
<p>(C) 2008, 2009 Kerim Mansour
For licensing information please refer to license.txt</p>
<dl class="class">
<dt id="pysvg.core.BaseElement">
<em class="property">class </em><tt class="descclassname">pysvg.core.</tt><tt class="descname">BaseElement</tt><big>(</big><em>elementName</em><big>)</big><a class="headerlink" href="#pysvg.core.BaseElement" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the base class for all svg elements like title etc. It provides common functionality.
It should NOT be directly used by anyone.</p>
<dl class="method">
<dt id="pysvg.core.BaseElement.getXML">
<tt class="descname">getXML</tt><big>(</big><big>)</big><a class="headerlink" href="#pysvg.core.BaseElement.getXML" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a XML representation of the current element.
This function can be used for debugging purposes. It is also used by getXML in SVG</p>
<p>&#64;return:  the representation of the current element as an xml string</p>
</dd></dl>

<dl class="method">
<dt id="pysvg.core.BaseElement.quote_attrib">
<tt class="descname">quote_attrib</tt><big>(</big><em>inStr</em><big>)</big><a class="headerlink" href="#pysvg.core.BaseElement.quote_attrib" title="Permalink to this definition">¶</a></dt>
<dd>Transforms characters between xml notation and python notation.</dd></dl>

<dl class="method">
<dt id="pysvg.core.BaseElement.save">
<tt class="descname">save</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#pysvg.core.BaseElement.save" title="Permalink to this definition">¶</a></dt>
<dd>Stores any element in a svg file (including header). 
Calling this method only makes sense if the root element is an svg elemnt</dd></dl>

<dl class="method">
<dt id="pysvg.core.BaseElement.wrap_xml">
<tt class="descname">wrap_xml</tt><big>(</big><em>xml</em><big>)</big><a class="headerlink" href="#pysvg.core.BaseElement.wrap_xml" title="Permalink to this definition">¶</a></dt>
<dd>Method that provides a standard svg header string for a file</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/api_core.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li><a href="index.html">pySVG v0.2.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Kerim Mansour.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
    </div>
  </body>
</html>